home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1999 July / Macworld (1999-07).dmg / Shareware World / Info / For Developers / FrontierMenu / Frontier Help next >
Text File  |  1999-04-30  |  11KB  |  277 lines
  1.  
  2.               Using Alpha as Frontier's external editor
  3.  
  4.                                Frontier menu 2.1.5
  5.                                 April 1999
  6.  
  7.  
  8. This document explains how to use Alpha as Frontier's external editor.
  9.  
  10. For help how to use Alpha as an HTML editor see the manual for HTML mode, 
  11. located in the folder HTML mode manual.
  12.  
  13. Please see the HTML mode home page, http://www.theophys.kth.se/~jl/Alpha.html
  14. for the latest version of HTML mode and Frontier menu. There you can also 
  15. download the HTML mode manual if you haven't got it already.
  16.  
  17. The code has been tested with Frontier 4.2.3, Frontier 5.0, and Frontier 
  18. 5.1.5.
  19.  
  20. I have two mailing list for information about updates, one for HTML mode 
  21. and one for Frontier menu. If you want me to put you on my lists, send me a 
  22. mail and tell me which lists you want to be on.
  23.  
  24. Johan Linde, <jlinde@telia.com>
  25.  
  26. Acknowledgments
  27.  
  28. Almost immediately after I had released Frontier menu 1.0 I got to know that
  29. Danis Georgiadis <dmg@hyper.gr> also had written some code to integrate 
  30. Alpha and Frontier. He generously gave me his code to freely use together 
  31. with mine. In this version I have taken the parts from his code which 
  32. could easily be integrated with mine and which worked without problems. The 
  33. Frontier database browser and the Scripts menu are both made by him. 
  34. When I made the Frontier shell I used some of Danis' code and some from 
  35. Matlab mode by Stephen Merkowitz <merk@lnf.infn.it>.
  36.  
  37. What's new in version 2.1.5
  38.  
  39. • In Alpha 7.2 windows with names containing brackets were not saved in 
  40. Frontier. Fixed!
  41. • See also the version history.
  42.  
  43. Installation and configuring
  44.  
  45. Installing verbs into Frontier
  46.  
  47. The five files
  48. system.startup.clearAlphaFiles
  49. shutdown.closeAlphaWindows
  50. system.verbs.apps.Alpha
  51. user.html.editors.Alpha
  52. user.Alpha
  53. must be imported into Frontier. You find these in the folder
  54. Frontier verbs. Just double-click the files to import them. Frontier 
  55. will ask for a name of the imported objects. Use the ones suggested.
  56.  
  57. Upgrading from version 2.1.2, 2.1.3, or 2.1.4
  58. None of the above files have been changed since version 2.1.2, 2.1.3 and 
  59. 2.1.4.
  60.  
  61. Upgrading from version 2.1.1
  62. Only the file system.verbs.apps.Alpha has to be imported into Frontier. 
  63. The other files have not changed since version 2.1.1.
  64.  
  65. Upgrading from version 2.0.x
  66. Only the three files
  67. system.verbs.apps.Alpha
  68. system.startup.clearAlphaFiles
  69. shutdown.closeAlphaWindows
  70. have to be imported into Frontier. The other two files have not changed 
  71. since version 2.0.x.
  72.  
  73. Upgrading from version 1.0
  74. All five files have to be imported into Frontier. The ones distributed with 
  75. Frontier menu 1.0 are not compatible with Frontier menu 2.1.4.
  76.  
  77. Other necessary changes to the Frontier database
  78.  
  79. There are also a few more changes you must do in Frontier:
  80. • Change the path in user.odbEditors.TextEditor to the path to Alpha, 
  81. otherwise Frontier will use the default editor BBEdit.
  82. • Similarly change the path in system.verbs.apps.Alpha.appinfo.path
  83. • A small change must be made to the verb suites.odbEditor.editors.Text.edit
  84.  
  85. The last lines reads
  86.  
  87. bundle «send an Apple Event to the editor to open the temp file
  88.     «use an open protocol that's implemented by BBEdit 4.0 and greater
  89.         «the extra parameter to the odoc event is Frontier's app id
  90.     appleEvent (ideditorapp, 'aevt', 'odoc', '----', alias (tempfile), 'FSnd', Frontier.id)
  91.     
  92. Change them to 
  93. bundle «send an Apple Event to the editor to open the temp file
  94.     if defined(Alpha.id) && ideditorapp == Alpha.id
  95.         Alpha.edit(tempfile)
  96.     else
  97.         «use an open protocol that's implemented by BBEdit 4.0 and greater
  98.             «the extra parameter to the odoc event is Frontier's app id
  99.         appleEvent (ideditorapp, 'aevt', 'odoc', '----', alias (tempfile), 'FSnd', Frontier.id)
  100.  
  101. This change is needed because Alpha doesn't understand the Apple event used 
  102. in the last line. Hopefully Alpha will understand it in the future so that 
  103. you don't have to make this change in the future. If you decide to switch 
  104. back to your previous editor you don't have to undo the above change. It 
  105. will work as before with any other editor.
  106.  
  107. Inserting the Frontier menu in the menu bar
  108. The Frontier menu doesn't automatically appear in the menu bar. 
  109. In Alpha 7.0 insert it in the menu bar by selecting Frontier menu in the submenu 
  110. Config -> Global -> Package Menus.
  111. In Alpha 7.1 open the dialog Config -> Global -> Menus and Features… and 
  112. check the Frontier menu checkbox.
  113.  
  114.  
  115. Opening a Frontier text window in Alpha
  116.  
  117. Text windows in Frontier can be opened in Alpha using Edit with App in 
  118. Frontier's Main menu. Whenever you save changes the Frontier database is 
  119. automatically updated. If you use 'Save as...' in Alpha the new file is 
  120. disconnected from the Frontier database.
  121.  
  122. You can also use the Frontier database browser, see below.
  123.  
  124. Frontier menu
  125.  
  126. Switch to Frontier - Launches Frontier or brings it to front if already 
  127.                      running.
  128.  
  129. Preview Page   -  Makes Frontier render the page and sends it to the 
  130.                   browser for previewing.  This is the same as 'Preview 
  131.                   Page' in Frontier's Web menu (or 'View in Browser' in 
  132.                   Frontier 4.2.3).  This should only be used for files 
  133.                   opened from Frontier.  Other HTML files are sent to the 
  134.                   browser using 'Send File to Browser' in the HTML menu.
  135.                   
  136. Publish Page   -  Makes Frontier render the page and publish it.  This is 
  137.                   the same as 'Publish Page' in Frontier's Web menu.  (This 
  138.                   function only works together with Frontier 5.)
  139.  
  140. Frontier Shell -  Opens a shell window where you can run Frontier scripts, 
  141.                   see below.
  142.                   
  143. Browse -          Opens a Frontier browser at different points in the database.
  144.                   Use Add… and Remove… to edit this menu.
  145.  
  146. Open -               Opens a Frontier window in Frontier. Use Add… and Remove… to 
  147.                   edit this menu.
  148.  
  149. Scripts Menu -       Rebuilds the Scripts menu and loads the script corresponding 
  150.                   to the menu items.
  151.  
  152. Preferences… -    To set your preferences for Frontier. Currently you can 
  153.                   choose if you want to automatically launch Frontier when 
  154.                   you launch Alpha. This is not done by default.
  155.  
  156. Scripts menu
  157.  
  158. The Scripts menu is a menu which you define inside Frontier in the same way as 
  159. you define shared menus for other applications. (The Scripts menu has the 
  160. cowboy menu icon like the Frontier scripts in the Finder.) The menu definition 
  161. must be in user.Alpha.menubar. Alpha does not support menu sharing. Therefore 
  162. there are a few things which differ from how shared menu work. In particular:
  163.  
  164. • If you launch Frontier after Alpha the menu it not automatically inserted 
  165. in the menubar. You have to use Rebuild Scripts Menu to insert it.
  166. • Whenever you modify the menu you have to use Rebuild Scripts Menu to 
  167. rebuild it. Note! This has also to be done when you modify a script belonging 
  168. to a menu item.
  169. • Keybindings for the menu items must be defined the way Alpha defines 
  170. keybindings. Alpha uses certain meta characters to define menu items. See 
  171. the section Menus, User-Defined in the general manual.
  172.  
  173. Frontier database browser
  174.  
  175. The Frontier database browser lets you navigate through Frontier's 
  176. database without leaving Alpha. You can also open Frontier windows in 
  177. Alpha without leaving Alpha. In the browser windows, tables are red, text 
  178. windows are green, and everything else is blue. To navigate the windows 
  179. you can use key shortcuts similar to those used to navigate Finder windows.
  180.  
  181. uparrow -         move up one line
  182.  
  183. downarrow -        move down one line
  184.  
  185. rightarrow -    rightarrow on a table displays the content of the table.
  186.  
  187. leftarrow -        leftarrow on a table hides the content of the table.
  188.  
  189. cmd uparrow -    opens the parent table in a new window.
  190.  
  191. cmd-opt uparrow - opens the parent table in a new window and closes the 
  192.                   current window.
  193.  
  194. cmd downarrow -    cmd downarrow on a table opens a new window with the 
  195.                 content of that table.
  196.  
  197. cmd-opt downarrow - cmd-opt downarrow on a table opens a new window with 
  198.                 the content of that table and closes the current window.
  199.  
  200. return -        opens the selected object for editing. Text objects are opened 
  201.                 in Alpha, and most other things are opened in Frontier.
  202.  
  203. Frontier shell
  204.  
  205. The Frontier shell is an alternative to the Frontier Quick Script window 
  206. for those who like a command history. Type a command and hit return to have it 
  207. executed in Frontier. The return value is then displayed on the next line.
  208.  
  209. You move up and down the command history using control-uparrow and 
  210. control-downarrow.
  211.  
  212. Control-u erases the current line.
  213.  
  214. WARNING! Don't send commands which will make Frontier open an alert window, 
  215. like e.g. dialog.notify. If this window is hidden behind your other 
  216. windows it will freeze your machine with command-option-escape as the only 
  217. way out.
  218.  
  219. Option-click in titlebar
  220.  
  221. Option-clicking in the titlebar of the Frontier shell window pops up a menu 
  222. with the command history. Selecting an item from this menu inserts the 
  223. text in the window. If the option key is held down while you select the 
  224. menu item the command is immediately evaluated, otherwise it is only 
  225. inserted so that you can edit it before evaluating it.
  226.  
  227. Version history
  228.  
  229. 2.1.5, 30 April 1999
  230. • In Alpha 7.2 windows with names containing brackets were not saved in 
  231. Frontier. Fixed!
  232.  
  233. 2.1.4, 25 April 1998
  234. • Fixed a startup problem. Alpha wouldn't launch completely when being 
  235. launched by dropping a file on it while Frontier was running, or by using 
  236. Edit with App in Frontier. 
  237.  
  238. 2.1.3, 1 March 1998
  239. • Compatibility fix for Alpha 7.1.
  240.  
  241. 2.1.2, 7 February 1998
  242. • Made 'View in Browser' compatible with Frontier 5, and renamed the menu 
  243. item to 'Preview Page', which it's called in Frontier 5.
  244. • Added 'Publish Page'. This only works with Frontier 5.
  245. • Improved error handling. In some cases Alpha would previously show 
  246. incorrect error messages.
  247. • Option-click in title bar of Frontier shell window pops up a menu with 
  248. the command history.
  249. • 'Save as…' now disconnects the window from the database, which is more 
  250. logical than the previous setup.
  251. • Some small bug fixes.
  252.  
  253. 2.1.1, 3 November 1997 [update of version 2.0.1]
  254. • The same as version 2.1 but for Alpha 7.0.
  255.  
  256. 2.1, 3 November 1997 [update of version 2.0]
  257. • A startup and a shutdown script to be imported into Frontier have been 
  258. added. Together they solve a problem which sometimes prevented the windows to 
  259. be saved into Frontier's database. The shutdown script closes all open 
  260. Frontier windows in Alpha. Thanks to Mike Carney <mike_carney@mediaone.net> 
  261. for ideas and some code snippets.
  262. • Various problems for windows with names containing brackets have been 
  263. fixed.
  264.  
  265. 2.0.1, 19 October 1997
  266. • Updated to be compatible with Alpha 7.0.
  267.  
  268. 2.0, 17 August 1997
  269. • Added a Frontier shell.
  270. • Added database browser and a Browse submenu.
  271. • Added the Open submenu.
  272. • Added Scripts menu, which is defined in Frontier as with other apps.
  273. • 'Save as...' works now.
  274.  
  275. 1.0, 20 July 1997
  276. First public release.
  277.